Interface: SHOP - XML e-documents Version 2012.40

This documentation describes the AbaConnect Interface XML e-documents for the SHOP Application.


General Information

General information about the AbaConnect interface.

AbaConnect Interface Information
Application :SHOP
Interface Name :XML e-documents
ID :XML E-Document ( Transactiondata )
Version :2012.40
Status:Productive


Displays the possible import and export features for this interface.

Export / Import Modus
Export :XML
Import :XML


Displays additional information for this interface.

Additional Information

                                  Highest field Revision for this interface : 0



Mapping Information

The following displays the Mapping details for this interface.

Mapping Information
Mapping ID :AbaDefault
Mapping Name :E-documents
Description :

                



Example AbaConnect XML Structure

The following is an example of an XML Header structure. This information is also visible in an AbaConnect XML Export file, that has been exported via the Abacus AbaConnect User Interface.

AbaConnect XML Struktur
<?xml version='1.0' encoding='UTF-8'?>
<AbaConnectContainer>
  <TaskCount>1</TaskCount>
  <Task>
    <Parameter>
      <Application>SHOP</Application>
      <Id>XML E-Document</Id>
      <MapId>AbaDefault</MapId>
      <Version>2012.40</Version>
      <!-- Attention : The client number (Mandant) is optional and implies that the data can only be imported into specified client (Mandant) -->
      <!-- The Client Option (Mandant) only has an influence when importing data. It can be configured in the AbaConnect Export Settings. -->
      <!-- By default, the client number (Mandant) is not written to the export file -->
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <EDocument mode='SAVE'>
          <!-- The specific data fields for the AbaConnect interface are included here. -->
      </EDocument>
    </Transaction>
  </Task>
</AbaConnectContainer>



Example AbaConnect Command Line

The following includes examples of AbaConnect Command Line. The AbaConnect Command Line is executed with the abaconnectexportconsole.exe and abaconnectimportconsole.exe programmes. The AbaConnect Command Line must be run direct on the Abacus server. More detailed information about AbaConnect Command Line is available on the Abacus Homepage. The following examples serve as starting point for creating a simple command line.

AbaConnect Command Line
Export :
abaconnectexportconsole.exe "/USRuser" "/PWxxx"  "-aSHOP"  "-version2012.40"  "-M7777"  "-acidXML E-Document"  "-mapidAbaDefault"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx"  "-aSHOP"  "-version2012.40"  "-M7777"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-importfileX:\data.xml"

N.B. : For importing XML data, it is not necessary to specify the Interface ID and Mapping on the Command Line. This information is contained in the XML Import file.



Mapping Structure

The following displays a simplified mapping structure for this interface.
The XML-Element and Parent-Name are always in english. Click on the row to display additional information.

XML Element Name Field Name Parent Name Type Length Mandatory
EDocumentE-document---Yes
    - DivisionDivisionEDocumentNumber8Yes
    - DocumentIDDocument IDEDocumentNumber14Yes
    - DocumentTypeType of documentEDocumentNumber4No
    - SubDocumentTypeMore accurate specification of the documentEDocumentNumber4No
    - AbaDocFileNameAbaDoc file nameEDocumentBinary-No
    - PdfFileNamePDF file nameEDocumentBinary-No
    - OrderNumberOrder IDEDocumentNumber14No
    - OrderSubNumberOrder sub-IDEDocumentNumber4No
    - ShopOrderNumberAbaShop order numberEDocumentNumber14No
    - ThirdPartyIdAdditional identificationEDocumentText50No
    - CustomerNumberCustomer no.EDocumentNumber14No
    - ThirdPartyCodeThird party status codeEDocumentNumber4No
    - ThirdPartyTextThird party textEDocumentText99999999No
    - InternalDocumentNumberInternal document numberEDocumentNumber14No
    - DirectionDirection of the documentEDocumentText8No



Field Information

The following is a detailed description of the fields used in this interface.

Division
XML Element Name:Division
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   8Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "Division")
                    

Document ID
XML Element Name:DocumentID
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "Id")
                    

Type of document
XML Element Name:DocumentType
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   4Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "DocType")
                    

More accurate specification of the document
XML Element Name:SubDocumentType
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   4Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "SubDocType")
                    

AbaDoc file name
XML Element Name:AbaDocFileName
Parent Element:EDocument
Field Type:Binary data
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "AbaDocFileName")
                    

PDF file name
XML Element Name:PdfFileName
Parent Element:EDocument
Field Type:Binary data
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   6
Description:

                                  (The internal field ID for this element is "PdfFileName")
                    

Order ID
XML Element Name:OrderNumber
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   7
Description:

                                  (The internal field ID for this element is "OrderNumber")
                    

Order sub-ID
XML Element Name:OrderSubNumber
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   4Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   8
Description:

                                  (The internal field ID for this element is "OrderSubNumber")
                    

AbaShop order number
XML Element Name:ShopOrderNumber
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   9
Description:

                                  (The internal field ID for this element is "ShopOrderNumber")
                    

Additional identification
XML Element Name:ThirdPartyId
Parent Element:EDocument
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   10
Description:

                                  (The internal field ID for this element is "ThirdPartyId")
                    

Customer no.
XML Element Name:CustomerNumber
Parent Element:EDocument
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   11
Description:

                                  (The internal field ID for this element is "CustomerNumber")
                    

Third party status code
XML Element Name:ThirdPartyCode
Parent Element:EDocument
Field Type:Nummer
Action Type:Import only
Field Length:   4Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   12
Description:

                                  (The internal field ID for this element is "ThirdPartyCode")
                    

Third party text
XML Element Name:ThirdPartyText
Parent Element:EDocument
Field Type:Text
Action Type:Import only
Field Length:   99999999Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   13
Description:

                                  (The internal field ID for this element is "ThirdPartyText")
                    

Internal document number
XML Element Name:InternalDocumentNumber
Parent Element:EDocument
Field Type:Nummer
Action Type:Export only
Field Length:   14Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   14
Description:

                                  (The internal field ID for this element is "InternalDocumentNumber")
                    

Direction of the document
XML Element Name:Direction
Parent Element:EDocument
Field Type:Text
Action Type:Export only
Field Length:   8Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   15
Description:

                                  (The internal field ID for this element is "Direction")